package one.microstream.util.similarity;

/*-
 * #%L
 * microstream-base
 * %%
 * Copyright (C) 2019 - 2022 MicroStream Software
 * %%
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 * 
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License, v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is
 * available at https://www.gnu.org/software/classpath/license.html.
 * 
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 * #L%
 */

/**
 * Since matching on similarity is a heuristic method, it can be necessary to have a validation callback logic
 * that can ultimately decide on potential matches.
 *
 * @param <E> the validated element's type
 */
@FunctionalInterface
public interface MatchValidator<E>
{
	public boolean isValidMatch(
		E      source              ,
		E      target              ,
		double similarity          ,
		int    sourceCandidateCount,
		int    targetCandidateCount
	);
}
